GitHub

Docker container for running virtual machines using QEMU.

Web-based viewer to control the machine directly from your browser

Supports .iso, .img, .qcow2, .vhd, .vhdx, .vdi, .vmdk and .raw disk formats

High-performance options (like KVM acceleration, kernel-mode networking, IO threading, etc.) to achieve near-native speed

Via Docker Compose:

Via Docker CLI:

Via Kubernetes:

Very simple! These are the steps:

Set the BOOT environment variable to the URL of any disk image you want to install.

Start the container and connect to port 8006 using your web browser.

You will see the screen and can now install the OS of your choice using your keyboard and mouse.

Enjoy your brand new machine, and don't forget to star this repo!

To change the storage location, include the following bind mount in your compose file:

Replace the example path /var/qemu with the desired storage folder.

To expand the default size of 16 GB, add the DISK_SIZE setting to your compose file and set it to your preferred capacity:

Tip

This can also be used to resize the existing disk to a larger capacity without any data loss.

You can use a local image file directly, and skip the download altogether, by binding it in your compose file:

This way you can supply a boot.iso, boot.img or boot.qcow2 file.

Note

The URL of the BOOT variable will be ignored in this case.

You can use qemu-arm to run ARM64-based images.

Use dockur/windows instead, as it includes all the drivers required during installation, amongst many other features.

Use dockur/macos instead, as it uses all the right settings and automaticly downloads the installation files.

By default, the machine makes use of virtio-scsi drives for performance reasons, and even though most Linux kernels bundle the necessary driver for this device, that may not always be the case for other operating systems.

If your machine fails to detect the hard drive, you can modify your compose file to use virtio-blk instead:

Tip

If it still fails to boot, you can set the value to ide to emulate a IDE drive, which is slow but requires no drivers and is compatible with almost every system.

By default, the container will be allowed to use a maximum of 1 CPU core and 1 GB of RAM.

If you want to adjust this, you can specify the desired amount using the following environment variables:

To verify that your system supports KVM, run the following commands:

If you receive an error from kvm-ok indicating that KVM acceleration can't be used, please check whether:

the virtualization extensions (Intel VT-x or AMD SVM) are enabled in your BIOS.

you are running an operating system that supports them, like Linux or Windows 11 (macOS and Windows 10 do not unfortunately).

you enabled "nested virtualization" if you are running the container inside a virtual machine.

you are not using a cloud provider, as most of them do not allow nested virtualization for their VPS's.

If you didn't receive any error from kvm-ok at all, but the container still complains that /dev/kvm is missing, it might help to add privileged: true to your compose file (or --privileged to your run command), to rule out any permission issue.

By default, the container uses bridge networking, which shares the IP address with the host.

If you want to assign an individual IP address to the container, you can create a macvlan network as follows:

Be sure to modify these values to match your local subnet.

Once you have created the network, change your compose file to look as follows:

An added benefit of this approach is that you won't have to perform any port mapping anymore, since all ports will be exposed by default.

Important

This IP address won't be accessible from the Docker host due to the design of macvlan, which doesn't permit communication between the two. If this is a concern, you need to create a second macvlan as a workaround.

After configuring the container for macvlan, it is possible for the VM to become part of your home network by requesting an IP from your router, just like a real PC.

To enable this mode, add the following lines to your compose file:

Note

In this mode, the container and the VM will each have their own separate IPs.

To create additional disks, modify your compose file like this:

It is possible to pass-through disk devices directly by adding them to your compose file in this way:

Use /disk1 if you want it to become your main drive, and use /disk2 and higher to add them as secondary drives.

To pass-through a USB device, first lookup its vendor and product id via the lsusb command, then add them to your compose file like this:

You can create the ARGUMENTS environment variable to provide additional arguments to QEMU at runtime:

The BOOT URL accepts files in any of the following formats:

Tip

It will also accept .img.gz, .qcow2.xz, .iso.zip and many more, as it automaticly extracts compressed files.